//////////////////////////////////////////////////////////////////////////////////
//
// ActionScript 3.0 Common Library (MIT License)
// Copyright (c) 2009 AS3CommonCode | Tony Birleffi | http://www.mosaiceye.com
// 
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////////////

package org.as3commoncode.utils
{
	import flash.display.DisplayObject;
	import flash.geom.Rectangle;	

	/**
	 * Utility class for determining if the mouse is currently within the bounds
	 * of any display object.
	 * 
	 * @author Tony Birleffi
	 */
	public class MouseUtil
	{
		/**
		 * Method used to determine if the mouse is within the bounds of a DisplayObject.
		 * 
		 * @example
		 * <listing>
         * import com.target.utils.MouseUtil;
         * var ifMouse:Boolean = MouseUtil.checkMouseInBounds(do);
         * </listing>
         *
		 * @param level				which sprite level.
		 * @param displayObject		any display object, sprite, movie clip, shape.
		 * @return Boolean.
		 */
		public static function checkMouseInBounds(displayObject:DisplayObject = null):Boolean
		{
			// Define.
			var res:Boolean = false;
			var rect:Rectangle;
			
			// If defined then continue.
			if(displayObject != null)
			{
				// Define the bounds rectangle.
				rect = displayObject.getBounds(displayObject);
			
				// Get the current mouse position
				var mouseX:Number = displayObject.mouseX;
				var mouseY:Number = displayObject.mouseY;
				
				// Check the x boundry, if in boundry then return true.
				if ((mouseX >= rect.left) && (mouseX <= rect.right))
				{
					// Check the y boundry.
					if ((mouseY >= rect.top) && (mouseY <= rect.bottom)) res = true;
				} 
				else res = false;
			}
			
			// Return.
			return res;
		}
	}
}